<html>
<head>
<title>Docs For Class HTML_Progress_UI</title>
<link rel="stylesheet" type="text/css" href="../../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: HTML_Progress_UI</h1>
Source Location: /Progress/UI.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre>HTML_Common
   |
   --HTML_Progress_UI</pre><br />
<div class="description"></div><br /><br />







</td>



<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodHTML_Progress_UI">HTML_Progress_UI</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methoddrawCircleSegments">drawCircleSegments</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetBorderAttributes">getBorderAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellAttributes">getCellAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCoordinates">getCellCoordinates</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCount">getCellCount</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetFillWay">getFillWay</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetOrientation">getOrientation</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetProgressAttributes">getProgressAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">getScript</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStringAttributes">getStringAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStyle">getStyle</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetBorderAttributes">setBorderAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">setCellAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCoordinates">setCellCoordinates</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCount">setCellCount</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetFillWay">setFillWay</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetOrientation">setOrientation</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetProgressAttributes">setProgressAttributes</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetScript">setScript</a></li>
    <li><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">setStringAttributes</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 35]<br />
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />


<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methodHTML_Progress_UI"></a>
	<h3>constructor HTML_Progress_UI <span class="smalllinenumber">[line 201]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>HTML_Progress_UI HTML_Progress_UI(
int
$cell)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		The progress bar's UI model class constructor<br /><br /><p>Constructor Summary</p><p><ul><li>Creates a natural horizontal progress bar that displays ten cells/units.
   <div class="listing"><pre><ol><li>   <span class="src-var">$html </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodHTML_Progress_UI">HTML_Progress_UI</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a natural horizontal progress bar with the specified cell count,
   which cannot be less than 1 (minimum), but has no maximum limit.
   <div class="listing"><pre><ol><li>   <span class="src-var">$html </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodHTML_Progress_UI">HTML_Progress_UI</a><span class="src-sym">(</span><span class="src-var">$cell</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">int&nbsp;&nbsp;</td>
        <td><b>$cell</b>&nbsp;&nbsp;</td>
        <td>(optional) Cell count</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddrawCircleSegments"></a>
	<h3>method drawCircleSegments <span class="smalllinenumber">[line 1059]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array drawCircleSegments(
[string
$dir = '.'], [string
$fileMask = 'c%s.png'])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Draw all circle segment pictures<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0RC1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$dir</b>&nbsp;&nbsp;</td>
        <td>(optional) Directory where pictures should be created</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$fileMask</b>&nbsp;&nbsp;</td>
        <td>(optional) sprintf format for pictures filename</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetBorderAttributes"></a>
	<h3>method getBorderAttributes <span class="smalllinenumber">[line 671]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getBorderAttributes(
[bool
$asString = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress bar's border attributes. Assoc array (defaut) or string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getborderattributes.pkg.html">HTML_Progress_UI::getBorderAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetBorderAttributes">HTML_Progress_UI::setBorderAttributes()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">bool&nbsp;&nbsp;</td>
        <td><b>$asString</b>&nbsp;&nbsp;</td>
        <td>(optional) whether to return the attributes as string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetCellAttributes"></a>
	<h3>method getCellAttributes <span class="smalllinenumber">[line 459]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getCellAttributes(
[bool
$asString = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the common and private cell attributes. Assoc array (defaut) or string<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getcellattributes.pkg.html">HTML_Progress_UI::getCellAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellAttributes">HTML_Progress_UI::setCellAttributes()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">bool&nbsp;&nbsp;</td>
        <td><b>$asString</b>&nbsp;&nbsp;</td>
        <td>(optional) whether to return the attributes as string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetCellCoordinates"></a>
	<h3>method getCellCoordinates <span class="smalllinenumber">[line 566]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array getCellCoordinates(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the coordinates of each cell for a polygonal progress shape.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>list of cell coordinates</td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCoordinates">HTML_Progress_UI::setCellCoordinates()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetCellCount"></a>
	<h3>method getCellCount <span class="smalllinenumber">[line 409]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getCellCount(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the number of cell in the progress bar. The default value is 10.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getcellcount.pkg.html">HTML_Progress_UI::getCellCount</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetCellCount">HTML_Progress_UI::setCellCount()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetFillWay"></a>
	<h3>method getFillWay <span class="smalllinenumber">[line 363]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getFillWay(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns 'natural' or 'reverse', depending of the fill way of progress bar.<br /><br /><p>For horizontal progress bar, natural way is from left to right, and reverse  way is from right to left.  For vertical progress bar, natural way is from down to up, and reverse  way is from up to down.  The default fill way is 'natural'.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getfillway.pkg.html">HTML_Progress_UI::getFillWay</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetFillWay">HTML_Progress_UI::setFillWay()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetOrientation"></a>
	<h3>method getOrientation <span class="smalllinenumber">[line 292]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>integer getOrientation(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns HTML_PROGRESS_BAR_HORIZONTAL or HTML_PROGRESS_BAR_VERTICAL,  depending on the orientation of the progress bar.<br /><br /><p>The default orientation is HTML_PROGRESS_BAR_HORIZONTAL.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getorientation.pkg.html">HTML_Progress_UI::getOrientation</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetOrientation">HTML_Progress_UI::setOrientation()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetProgressAttributes"></a>
	<h3>method getProgressAttributes <span class="smalllinenumber">[line 794]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getProgressAttributes(
[bool
$asString = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the progress attributes. Assoc array (defaut) or string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getprogressattributes.pkg.html">HTML_Progress_UI::getProgressAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetProgressAttributes">HTML_Progress_UI::setProgressAttributes()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">bool&nbsp;&nbsp;</td>
        <td><b>$asString</b>&nbsp;&nbsp;</td>
        <td>(optional) whether to return the attributes as string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetScript"></a>
	<h3>method getScript <span class="smalllinenumber">[line 859]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getScript(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get the javascript code to manage progress bar.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>JavaScript URL or inline code to manage progress bar</td>
  </tr>
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Christian Wenz &lt;<a href="mailto:wenz@php.net">wenz@php.net</a>&gt; Helper.              See details on thanks section of README file.</td>
  </tr>
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Stefan Neufeind &lt;<a href="mailto:pear.neufeind@speedpartner.de">pear.neufeind@speedpartner.de</a>&gt; Contributor.              See details on thanks section of README file.</td>
  </tr>
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getscript.pkg.html">HTML_Progress_UI::getScript</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetScript">HTML_Progress_UI::setScript()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>0.5</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetStringAttributes"></a>
	<h3>method getStringAttributes <span class="smalllinenumber">[line 728]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed getStringAttributes(
[bool
$asString = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the string attributes. Assoc array (defaut) or string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getstringattributes.pkg.html">HTML_Progress_UI::getStringAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodsetStringAttributes">HTML_Progress_UI::setStringAttributes()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">bool&nbsp;&nbsp;</td>
        <td><b>$asString</b>&nbsp;&nbsp;</td>
        <td>(optional) whether to return the attributes as string</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetStyle"></a>
	<h3>method getStyle <span class="smalllinenumber">[line 981]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object HTML_CSS &amp;getStyle(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Get the cascading style sheet to put inline on HTML document<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>instance</td>
  </tr>
  <tr>
    <td><b>author:</b>&nbsp;&nbsp;</td><td>Stefan Neufeind &lt;<a href="mailto:pear.neufeind@speedpartner.de">pear.neufeind@speedpartner.de</a>&gt; Contributor.              See details on thanks section of README file.</td>
  </tr>
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.getstyle.pkg.html">HTML_Progress_UI::getStyle</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>0.2</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetBorderAttributes"></a>
	<h3>method setBorderAttributes <span class="smalllinenumber">[line 709]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setBorderAttributes(
mixed
$attributes)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's border attributes.<br /><br /><p>Defaults are:  <ul><li>class   = progressBarBorder</li><li>width   = 0</li><li>style   = solid</li><li>color   = #000000</li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setborderattributes.pkg.html">HTML_Progress_UI::setBorderAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetBorderAttributes">HTML_Progress_UI::getBorderAttributes()</a>, <a href="../../HTML_Progress/HTML_Progress.html#methodsetBorderPainted">HTML_Progress::setBorderPainted()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>Associative array or string of HTML tag attributes</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetCellAttributes"></a>
	<h3>method setCellAttributes <span class="smalllinenumber">[line 517]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setCellAttributes(
mixed
$attributes, [int
$cell = null])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the cell attributes for an existing cell.<br /><br /><p>Defaults are:  <ul><li>Common :
     <ul><li>id             = progressCell%01s</li><li>class          = cell</li><li>spacing        = 2</li><li>active-color   = #006600</li><li>inactive-color = #CCCCCC</li><li>font-family    = Courier, Verdana</li><li>font-size      = lowest value from cell width, cell height, and font size</li><li>color          = #000000</li><li>background-color = #FFFFFF (added for progress circle shape on release 1.2.0)</li><li>Horizontal Bar :
         <ul><li>width      = 15</li><li>height     = 20</li></ul></li><li>Vertical Bar :
         <ul><li>width      = 20</li><li>height     = 15</li></ul></li></ul></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setcellattributes.pkg.html">HTML_Progress_UI::setCellAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellAttributes">HTML_Progress_UI::getCellAttributes()</a>, <a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCount">HTML_Progress_UI::getCellCount()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>Associative array or string of HTML tag attributes</td>
      </tr>
          <tr>
        <td class="type">int&nbsp;&nbsp;</td>
        <td><b>$cell</b>&nbsp;&nbsp;</td>
        <td>(optional) Cell index</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetCellCoordinates"></a>
	<h3>method setCellCoordinates <span class="smalllinenumber">[line 583]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setCellCoordinates(
integer
$xgrid, integer
$ygrid, [array
$coord = array()])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set the coordinates of each cell for a polygonal progress shape.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCoordinates">HTML_Progress_UI::getCellCoordinates()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.2.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$xgrid</b>&nbsp;&nbsp;</td>
        <td>The grid width in cell size</td>
      </tr>
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$ygrid</b>&nbsp;&nbsp;</td>
        <td>The grid height in cell size</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$coord</b>&nbsp;&nbsp;</td>
        <td>(optional) Coordinates (x,y) in the grid, of each cell</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetCellCount"></a>
	<h3>method setCellCount <span class="smalllinenumber">[line 426]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setCellCount(
integer
$cells)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the number of cell in the progress bar<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setcellcount.pkg.html">HTML_Progress_UI::setCellCount</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetCellCount">HTML_Progress_UI::getCellCount()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$cells</b>&nbsp;&nbsp;</td>
        <td>Cell count on progress bar</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetFillWay"></a>
	<h3>method setFillWay <span class="smalllinenumber">[line 381]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setFillWay(
string
$way)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's fill way, which must be 'natural' or 'reverse'.<br /><br /><p>The default fill way is 'natural'.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setfillway.pkg.html">HTML_Progress_UI::setFillWay</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetFillWay">HTML_Progress_UI::getFillWay()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$way</b>&nbsp;&nbsp;</td>
        <td>fill direction (natural or reverse)</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetOrientation"></a>
	<h3>method setOrientation <span class="smalllinenumber">[line 311]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setOrientation(
integer
$orient)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the progress bar's orientation, which must be HTML_PROGRESS_BAR_HORIZONTAL  or HTML_PROGRESS_BAR_VERTICAL.<br /><br /><p>The default orientation is HTML_PROGRESS_BAR_HORIZONTAL.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setorientation.pkg.html">HTML_Progress_UI::setOrientation</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetOrientation">HTML_Progress_UI::getOrientation()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$orient</b>&nbsp;&nbsp;</td>
        <td>Orientation (horizontal or vertical)</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetProgressAttributes"></a>
	<h3>method setProgressAttributes <span class="smalllinenumber">[line 841]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setProgressAttributes(
mixed
$attributes)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the common progress bar attributes.<br /><br /><p>Defaults are:  <ul><li>class             = progressBar</li><li>background-color  = #FFFFFF</li><li>auto-size         = true</li><li>Horizontal Bar :
     <ul><li>width         = (cell_count * (cell_width + cell_spacing)) + cell_spacing</li><li>height        = cell_height + (2 * cell_spacing)</li></ul></li><li>Vertical Bar :
     <ul><li>width         = cell_width + (2 * cell_spacing)</li><li>height        = (cell_count * (cell_height + cell_spacing)) + cell_spacing</li></ul></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setprogressattributes.pkg.html">HTML_Progress_UI::setProgressAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetProgressAttributes">HTML_Progress_UI::getProgressAttributes()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>Associative array or string of HTML tag attributes</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetScript"></a>
	<h3>method setScript <span class="smalllinenumber">[line 944]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setScript(
string
$url)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Set the external JavaScript code (file) to manage progress element.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setscript.pkg.html">HTML_Progress_UI::setScript</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetScript">HTML_Progress_UI::getScript()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$url</b>&nbsp;&nbsp;</td>
        <td>URL to the linked Progress JavaScript</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetStringAttributes"></a>
	<h3>method setStringAttributes <span class="smalllinenumber">[line 777]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setStringAttributes(
mixed
$attributes)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the string attributes.<br /><br /><p>Defaults are:  <ul><li>id                = installationProgress</li><li>width             = 50</li><li>font-family       = Verdana, Arial, Helvetica, sans-serif</li><li>font-size         = 12</li><li>color             = #000000</li><li>background-color  = #FFFFFF</li><li>align             = right</li><li>Horizontal Bar :
     <ul><li>valign        = right</li></ul></li><li>Vertical Bar :
     <ul><li>valign        = bottom</li></ul></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>tutorial:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/tutorial_ui.setstringattributes.pkg.html">HTML_Progress_UI::setStringAttributes</a></td>
  </tr>
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_UI/HTML_Progress_UI.html#methodgetStringAttributes">HTML_Progress_UI::getStringAttributes()</a>, <a href="../../HTML_Progress/HTML_Progress.html#methodsetStringPainted">HTML_Progress::setStringPainted()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>Associative array or string of HTML tag attributes</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:45 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>